home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 26.zip / BS1 part 26 / Cando v1.6 disk 2.adf / HelpFiles / Screen and Window  < prev    next >
Text File  |  1992-01-14  |  9KB  |  508 lines
  1. C- GetViewOffset        |getviewoffset|
  2. C- GetWindowLimits        |getwindowlimits|
  3. V- HiRes                |hires|
  4. V- Interlace            |interlace|
  5. V- MouseX                |mousex|
  6. V- MouseY                |mousey|
  7. C- MoveScreen            |movescreen|
  8. C- MoveWindow            |movewindow|
  9. V- NTSC                    |ntsc|
  10. C- Pointer                |pointer|
  11. C- ResizeWindow            |resizewindow|
  12. V- ScreenAddress        |screenaddress|
  13. V- ScreenColors            |screencolors|
  14. V- ScreenHeight            |screenheight|
  15. V- ScreenTitle            |screentitle|
  16. C- ScreenTitleBar        |screentitlebar|
  17. C- ScreenTo                |screento|
  18. V- ScreenWidth            |screenwidth|
  19. V- ScreenX                |screenx|
  20. V- ScreenY                |screeny|
  21. C- SetPointer            |setpointer|
  22. C- SetScreenTitle        |setscreentitle|
  23. C- SetViewOffset        |setviewoffset|
  24. C- SetWindowLimits        |setwindowlimits|
  25. C- SetWindowTitle        |setwindowtitle|
  26. V- WindowAddress        |windowaddress|
  27. V- WindowBorderBottom    |windowborderbottom|
  28. V- WindowBorderLeft        |windowborderleft|
  29. V- WindowBorderRight    |windowborderright|
  30. V- WindowBorderTop        |windowbordertop|
  31. V- WindowColors            |windowcolors|
  32. V- WindowHeight            |windowheight|
  33. V- WindowName            |windowname|
  34. V- WindowTitle            |windowtitle|
  35. C- WindowTo                |windowto|
  36. V- WindowWidth            |windowwidth|
  37. V- WindowX                |windowx|
  38. V- WindowY                |windowy|
  39. V- WorkbenchColors        |workbenchcolors|
  40. V- WorkbenchHeight        |workbenchheight|
  41. V- WorkbenchWidth        |workbenchwidth|
  42. [E]
  43.  
  44. |getviewoffset|
  45. WT GetViewOffset <XVarName>, <YVarName>
  46. PL Returns the view offset.  This is commonly
  47. PT used with 
  48. BS SetViewOffset
  49. PL  to find out the
  50. PL views current offset so that an calculated
  51. PL move can be made or to store off the
  52. PL original offset.
  53. ED
  54.  
  55. |getwindowlimits|
  56. WT GetWindowLimits <MinWidthVarName>, <MinHeightVarName>, <MaxWidthVarName>, <MaxHeightVarName>
  57. PL Returns the current window sizing limits
  58. PL into the specified variables.
  59. PL
  60. PT SEE ALSO: 
  61. BS SetWindowLimits
  62. PT .
  63. ED
  64.  
  65. |hires|
  66. WT {Logical}=HiRes
  67. PT This returns 
  68. BS True
  69. PL  when the current card's
  70. PL screen is in High-Resolution mode.  High-
  71. PL resolution mode used 60ns pixels and 
  72. PL normally has 640 pixels horizontally.
  73. PL
  74. PT SEE ALSO: 
  75. BS Interlace
  76. PT .
  77. ED
  78.  
  79. |interlace|
  80. WT {Logical}=Interlace
  81. PT This returns 
  82. BS True
  83. PL  when the current card's
  84. PL screen is in Interlace mode.  Interlace
  85. PL mode causes normal displays to flicker and
  86. PL normally has 400/512 pixels vertically.
  87. PL
  88. PT SEE ALSO: 
  89. BS HiRes
  90. PT .
  91. ED
  92.  
  93. |mousex|
  94. WT {Integer}=MouseX
  95. PL This returns the mouse's X coordinate
  96. PL when this event was caused.  If no event
  97. PL script is running then this returns the last
  98. PL known X position of the mouse.
  99. PL
  100. PT SEE ALSO: 
  101. BS MouseY
  102. PT .
  103. ED
  104.  
  105. |mousey|
  106. WT {Integer}=MouseY
  107. PL This returns the mouse's Y coordinate
  108. PL when this event was caused.  If no event
  109. PL script is running then this returns the last
  110. PL known Y position of the mouse.
  111. PL
  112. PT SEE ALSO: 
  113. BS MouseX
  114. PT .
  115. ED
  116.  
  117. |movescreen|
  118. WT MoveScreen {DeltaX}, {DeltaY}
  119. PL Move the screen a specified number of pixels
  120. PL right/left {DeltaX}, or up/down {DeltaY}.
  121. PL Note: Under AmigaDOS 1.3, right/left and
  122. PL up doesn't work all that well.
  123. PL
  124. PT SEE ALSO: 
  125. BS ScreenX
  126. PT  and 
  127. BS ScreenY
  128. PT .
  129. ED
  130.  
  131. |movewindow|
  132. WT MoveWindow {DeltaX}, {DeltaY}
  133. PL Move the window a specified number of pixels
  134. PL right/left {DeltaX}, or up/down {DeltaY}.
  135. PL
  136. PT SEE ALSO: 
  137. BS WindowX
  138. PT  and 
  139. BS WindowY
  140. PT .
  141. ED
  142.  
  143. |ntsc|
  144. WT {Logical}=NTSC
  145. PL If the deck is running on a NTSC system
  146. PT this variable will return 
  147. BS True
  148. PL .  When
  149. PL running on a PAL system it will return
  150. PT a 
  151. BS False
  152. PL .
  153. ED
  154.  
  155. |pointer|
  156. WT Pointer {Logical}
  157. PT Turns the mouse pointer 
  158. BS On
  159. PT  or 
  160. BS Off
  161. PT .
  162. PL
  163. PT SEE ALSO: 
  164. BS SetPointer
  165. PT .
  166. ED
  167.  
  168. |resizewindow|
  169. WT ResizeWindow {width}, {height}
  170. PL Resize the window to a new width and height.
  171. PL
  172. PT SEE ALSO: 
  173. BS WindowWidth
  174. PT  and 
  175. BS WindowHeight
  176. PT .
  177. ED
  178.  
  179. |screenaddress|
  180. WT {Integer}=ScreenAddress
  181. PL Returns a integer that is a pointer to the
  182. PL current window's screen.
  183. ED
  184.  
  185. |screencolors|
  186. WT {Integer}=ScreenColors
  187. PL This returns the number of colors available
  188. PL for the current screen.
  189. PL
  190. PT SEE ALSO: 
  191. BS WindowColors
  192. PT .
  193. ED
  194.  
  195. |screenheight|
  196. WT {Integer}=ScreenHeight
  197. PL This returns the height of the current
  198. PL screen.
  199. PL
  200. PT SEE ALSO: 
  201. BS WindowHeight
  202. PT .
  203. ED
  204.  
  205. |screentitle|
  206. WT {String}=ScreenTitle
  207. PL This returns the titlebar text of the
  208. PL current screen.
  209. PL
  210. PT SEE ALSO: 
  211. BS WindowTitle
  212. PT .
  213. ED
  214.  
  215. |screentitlebar|
  216. WT ScreenTitleBar {Logical}
  217. PL If using a custom screen, this command
  218. PL allows the screen's title bar to be
  219. PL displayed if the logical expression is
  220. PT 
  221. BS True
  222. PT , or hidden if it is 
  223. BS False
  224. PL .
  225. PL NOTE: The window's title bar may hide
  226. PL       the screen's title, even if TRUE
  227. ED
  228.  
  229. |screento|
  230. WT ScreenTo <flags>
  231. PL Moves the screen to front or back depending
  232. PL on the flag settings.  See pages 4-18 and
  233. PL 6-35 in the yellow manual for a full
  234. PL description of this command.
  235. PL 
  236. PT SEE ALSO: 
  237. BS WindowTo
  238. PT .
  239. ED
  240.  
  241. |screenwidth|
  242. WT {Integer}=ScreenWidth
  243. PL This returns the width of the current
  244. PL screen.
  245. PL
  246. PT SEE ALSO: 
  247. BS WindowWidth
  248. PT .
  249. ED
  250.  
  251. |screenx|
  252. WT {Integer}=ScreenX
  253. PL This returns the current screen's X offset
  254. PL from the system's master view.
  255. PL
  256. PT SEE ALSO: 
  257. BS ScreenY
  258. PT .
  259. ED
  260.  
  261. |screeny|
  262. WT {Integer}=ScreenY
  263. PL This returns the current screen's Y offset
  264. PL from the system's master view.
  265. PL
  266. PT SEE ALSO: 
  267. BS ScreenX
  268. PT .
  269. ED
  270.  
  271. |setpointer|
  272. WT SetPointer [{BrushBufferName} [,{XHotSpot}, {YHotSpot}]]
  273. PL Use a DPaint style brush as the mouse
  274. PL pointer.  If given, {XHotSpot} and
  275. PL {YHotSpot} indicate the mouse's "hotspot".
  276. PL If no parameters are given, we will use the
  277. PL system pointer.
  278. PT SEE ALSO: 
  279. BS Pointer
  280. PT  and 
  281. BS SetBusyPointer
  282. PT .
  283. ED
  284.  
  285. |setscreentitle|
  286. WT SetScreenTitle {String}
  287. PL This will change the screen's titlebar
  288. PL text display.
  289. PL
  290. PT SEE ALSO: 
  291. BS ScreenTitle
  292. PT  and 
  293. BS ScreenTitleBar
  294. PT .
  295. ED
  296.  
  297. |setviewoffset|
  298. WT SetViewOffset {X}, {Y}
  299. PL Changes the system's view offset.  Used
  300. PT with 
  301. BS GetViewOffset
  302. PL .  NOTE: Use this
  303. PL with great caution.
  304. ED
  305.  
  306. |setwindowlimits|
  307. WT SetWindowLimits {MinWidth}, {MinHeight}, {MaxWidth}, {MaxHeight}
  308. PL Defines the window's sizing limits to be
  309. PL between {MinWidth} and {MaxWidth}
  310. PL horizontally and between {MinHeight} and
  311. PL {MaxHeight} vertically.
  312. PL
  313. PT SEE ALSO: 
  314. BS GetWindowLimits
  315. PT .
  316. ED
  317.  
  318. |setwindowtitle|
  319. WT SetWindowTitle {String}
  320. PL This will change the window's titlebar
  321. PL text display.
  322. PL
  323. PT SEE ALSO: 
  324. BS WindowTitle
  325. PT .
  326. ED
  327.  
  328. |windowaddress|
  329. WT {Integer}=WindowAddress
  330. PL Returns a integer that is a pointer to the
  331. PL current window.
  332. ED
  333.  
  334. |windowborderbottom|
  335. WT {Integer}=WindowBorderBottom
  336. PL This returns the height of the bottom
  337. PL window border.  This is affected by the
  338. PL border flag in window options.
  339. PL
  340. PT SEE ALSO: 
  341. BS WindowBorderTop
  342. PT , 
  343. BS WindowBorderLeft
  344. PL
  345. PT           and 
  346. BS WindowBorderRight
  347. PT .
  348. ED
  349.  
  350. |windowborderleft|
  351. WT {Integer}=WindowBorderLeft
  352. PL This returns the width of the left
  353. PL window border.  This is affected by the
  354. PL border flag in window options.
  355. PL
  356. PT SEE ALSO: 
  357. BS WindowBorderTop
  358. PL , 
  359. PT   
  360. BS WindowBorderBottom
  361. PT  and 
  362. BS WindowBorderRight
  363. PT .
  364. ED
  365.  
  366. |windowborderright|
  367. WT {Integer}=WindowBorderRight
  368. PL This returns the width of the right
  369. PL window border.  This is affected by the
  370. PL border flag in window options.
  371. PL
  372. PT SEE ALSO: 
  373. BS WindowBorderTop
  374. PT , 
  375. BS WindowBorderLeft
  376. PL
  377. PT           and 
  378. BS WindowBorderBottom
  379. PT .
  380. ED
  381.  
  382. |windowbordertop|
  383. WT {Integer}=WindowBorderTop
  384. PL This returns the height of the top
  385. PL window border.  This is affected by the
  386. PL border flag in window options and the
  387. PL font size of the current screen.
  388. PT SEE ALSO: 
  389. BS WindowBorderBottom
  390. PL , 
  391. PT     
  392. BS WindowBorderLeft
  393. PT  and 
  394. BS WindowBorderRight
  395. PT .
  396. ED
  397.  
  398. |windowcolors|
  399. WT {Integer}=WindowColors
  400. PL This returns the number of colors available
  401. PL for the current window.
  402. PL
  403. PT SEE ALSO: 
  404. BS ScreenColors
  405. PT .
  406. ED
  407.  
  408. |windowheight|
  409. WT {Integer}=WindowHeight
  410. PL This returns the height of the current
  411. PL window.
  412. PL
  413. PT SEE ALSO: 
  414. BS ScreenHeight
  415. PT .
  416. ED
  417.  
  418. |windowname|
  419. WT {String}=WindowName
  420. PL This returns the object name of the current
  421. PL window.  Under normal cases this will
  422. PL always be "UserWindow"
  423. ED
  424.  
  425. |windowtitle|
  426. WT {String}=WindowTitle
  427. PL This returns the titlebar text of the
  428. PL current window.
  429. PL
  430. PT SEE ALSO: 
  431. BS ScreenTitle
  432. PT .
  433. ED
  434.  
  435. |windowto|
  436. WT WindowTo <flags>
  437. PL Moves the window to front or back depending
  438. PL on the flag settings.  See pages 4-18 and
  439. PL 6-36 in the yellow manual for a full
  440. PL description of this command.
  441. PL 
  442. PT SEE ALSO: 
  443. BS ScreenTo
  444. PT .
  445. ED
  446.  
  447. |windowwidth|
  448. WT {Integer}=WindowWidth
  449. PL This returns the width of the current
  450. PL window.
  451. PL
  452. PT SEE ALSO: 
  453. BS ScreenWidth
  454. PT .
  455. ED
  456.  
  457. |windowx|
  458. WT {Integer}=WindowX
  459. PL This returns the current window's X offset
  460. PL from its screen origin.
  461. PL
  462. PT SEE ALSO: 
  463. BS WindowY
  464. PT .
  465. ED
  466.  
  467. |windowy|
  468. WT {Integer}=WindowY
  469. PL This returns the current window's Y offset
  470. PL from its screen origin.
  471. PL
  472. PT SEE ALSO: 
  473. BS WindowX
  474. PT .
  475. ED
  476.  
  477. |workbenchcolors|
  478. WT {Integer}=WorkbenchColors
  479. PL This returns the number of colors available
  480. PL on the workbench screen.
  481. PL
  482. PT SEE ALSO: 
  483. BS ScreenColors
  484. PT .
  485. ED
  486.  
  487. |workbenchheight|
  488. WT {Integer}=WorkbenchHeight
  489. PL This returns the height of the workbench
  490. PL screen.
  491. PL
  492. PT SEE ALSO: 
  493. BS ScreenHeight
  494. PT .
  495. ED
  496.  
  497. |workbenchwidth|
  498. WT {Integer}=WorkbenchWidth
  499. PL This returns the width of the workbench
  500. PL screen.
  501. PL
  502. PT SEE ALSO: 
  503. BS ScreenWidth
  504. PT .
  505. ED
  506.  
  507.  
  508.